/*
 * Copyright 2009 Max Kugland
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.splink.deepsplink.navigation {
	import org.splink.library.IFinalizable;

	/**
	 * Defines the basic capabilities of an <code>IPageNavigationController</code>
	 *The default implementation is <code>PageNavigation</code>
	 * 
	 * @see org.splink.deepsplink.navigation.PageNavigation
	 * 
	 * @author Max Kugland
	 */
	public interface IPageNavigationController extends IFinalizable {
		
		/**
		 * Adds a view
		 * 
		 * @param view the <code>IPageNavigationView</code> implementation to add
		 */
		function addView(view : IPageNavigationView) : IPageNavigationView;
		
		/**
		 * Removes a view
		 * 
		 * @param view the <code>IPageNavigationView</code> implementation to remove
		 */
		function removeView(view : IPageNavigationView) : IPageNavigationView;
		
		/**
		 * Requests the framework to change from the current page to the page belonging to the given pageId
		 * 
		 * @param pageId the id of the page (or subpage) which will be displayed next
		 */
		function gotoPage(pageId : String, pageParams : Array = null) : void;
	}
}
